/**
 *
 *    geo-platform
 *    Rich webgis framework
 *    http://geo-platform.org
 *   ====================================================================
 *
 *   Copyright (C) 2008-2021 geoSDI Group (CNR IMAA - Potenza - ITALY).
 *
 *   This program is free software: you can redistribute it and/or modify it
 *   under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version. This program is distributed in the
 *   hope that it will be useful, but WITHOUT ANY WARRANTY; without
 *   even the implied warranty of MERCHANTABILITY or FITNESS FOR
 *   A PARTICULAR PURPOSE. See the GNU General Public License
 *   for more details. You should have received a copy of the GNU General
 *   Public License along with this program. If not, see http://www.gnu.org/licenses/
 *
 *   ====================================================================
 *
 *   Linking this library statically or dynamically with other modules is
 *   making a combined work based on this library. Thus, the terms and
 *   conditions of the GNU General Public License cover the whole combination.
 *
 *   As a special exception, the copyright holders of this library give you permission
 *   to link this library with independent modules to produce an executable, regardless
 *   of the license terms of these independent modules, and to copy and distribute
 *   the resulting executable under terms of your choice, provided that you also meet,
 *   for each linked independent module, the terms and conditions of the license of
 *   that module. An independent module is a module which is not derived from or
 *   based on this library. If you modify this library, you may extend this exception
 *   to your version of the library, but you are not obligated to do so. If you do not
 *   wish to do so, delete this exception statement from your version.
 */
package org.geosdi.geoplatform.jaxb.validation.configuration;

import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import org.geosdi.geoplatform.jaxb.validation.configuration.ISeverityType.SeverityType;
import org.geosdi.geoplatform.jaxb.validation.configuration.adapter.ValidationMessageAdapter;
import org.geosdi.geoplatform.jaxb.validation.configuration.severity.ErrorSeverityMessage;
import org.geosdi.geoplatform.jaxb.validation.configuration.severity.FatalErrorSeverityMessage;
import org.geosdi.geoplatform.jaxb.validation.configuration.severity.WarningSeverityMessage;
import org.geosdi.geoplatform.jaxb.validation.xsd.message.IXSDValidationMessage;

import javax.xml.bind.annotation.XmlSeeAlso;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import java.io.Serializable;


/**
 * @author Giuseppe La Scaleia - CNR IMAA geoSDI Group
 * @email giuseppe.lascaleia@geosdi.org
 */
@XmlJavaTypeAdapter(value = ValidationMessageAdapter.class)
@XmlSeeAlso(value = {GPValidationMessage.class, IXSDValidationMessage.class})
public interface ValidationMessage extends Serializable, Comparable<ValidationMessage> {

    /**
     * @return {@link String}
     */
    String getMessage();

    /**
     * @param theMessage
     */
    void setMessage(String theMessage);

    /**
     * @param <S>
     * @return {@link S}
     */
    <S extends ISeverityMessage> S getSeverityMessage();

    /**
     * @param theSeverityMessage
     * @param <S>
     */
    <S extends ISeverityMessage> void setSeverityMessage(S theSeverityMessage);

    /**
     * @return {@link ValidationType}
     */
    default ValidationType getValidationType() {
        return ValidationType.LOGIC;
    }

    /**
     *
     */
    @JsonTypeInfo(
            use = JsonTypeInfo.Id.NAME,
            include = JsonTypeInfo.As.EXISTING_PROPERTY,
            property = "type")
    @JsonSubTypes({
            @JsonSubTypes.Type(value = WarningSeverityMessage.class, name = "WARNING"),
            @JsonSubTypes.Type(value = ErrorSeverityMessage.class, name = "ERROR"),
            @JsonSubTypes.Type(value = FatalErrorSeverityMessage.class, name = "FATAL_ERROR")})
    interface ISeverityMessage<S extends ISeverityMessage> extends Comparable<S> {

        /**
         * @return {@link Integer}
         */
        Integer getDegree();

        /**
         * @return {@link SeverityType}
         */
        SeverityType getType();

        /**
         * @param o
         * @return
         */
        default int compareTo(S o) {
            return o.getDegree().compareTo(getDegree());
        }
    }

    /**
     *
     */
    enum ValidationType {
        XSD, LOGIC;
    }
}